Package | ihe.iti.pmir |
Type | CapabilityStatement |
Id | Id |
FHIR Version | R4 |
Source | https://profiles.ihe.net/ITI/PMIR/https://build.fhir.org/ig/IHE/ITI.PMIR/CapabilityStatement-IHE.PMIR.PatientIdentityRegistry.html |
Url | https://profiles.ihe.net/ITI/PMIR/CapabilityStatement/IHE.PMIR.PatientIdentityRegistry |
Version | 1.5.1-current |
Status | active |
Date | 2022-10-27 |
Name | IHE_PMIR_PatientIdentityRegistry |
Title | IHE PMIR Patient Identity Registry |
Experimental | False |
Realm | uv |
Authority | ihe |
Description | CapabilityStatement for the Patient Identity Registry Actor in the IHE IT Infrastructure Technical Framework Supplement [IHE PMIR](index.html). |
Kind | requirements |
No resources found
StructureDefinition | |
IHE.PMIR.Subscription.Request | IHE Patient Master Identity Registry Subscription request |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.PMIR.PatientIdentityRegistry
application/fhir+xml
, application/fhir+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
Subscription | Supported Profiles IHE Patient Master Identity Registry Subscription request | y | y | y | y | |||||
Patient | y | y | _id, active, address-city, address-country, address-postalcode, address-state, birthdate, family, gender, given, identifier, telecom, _lastUpdated, mothersMaidenName |
create
, read
, update
, delete
.For Subscribe to Patient Updates [ITI-94]
For Mobile Patient Identifier Cross-reference Query [ITI-83] and Mobile Patient Demographics Query [ITI-78]
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | active | token | Whether the patient record is active |
SHALL | address-city | string | A city specified in an address |
SHALL | address-country | string | A country specified in an address |
SHALL | address-postalcode | string | A postalCode specified in an address |
SHALL | address-state | string | A state specified in an address |
SHALL | birthdate | date | The patient's date of birth |
SHALL | family | string | A portion of the family name of the patient |
SHALL | gender | token | Gender of the patient |
SHALL | given | string | A portion of the given name of the patient |
SHALL | identifier | token | A patient identifier |
SHALL | telecom | token | The value in any kind of telecom details of the patient |
SHALL | _lastUpdated | date | When the resource version last changed |
SHALL | mothersMaidenName | string | Mother's maiden (unmarried) name, commonly collected to help verify patient identity. |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $$ihe-pix |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.PMIR.PatientIdentityRegistry",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.PMIR.PatientIdentityRegistry</b></p><a name=\"IHE.PMIR.PatientIdentityRegistry\"> </a><a name=\"hcIHE.PMIR.PatientIdentityRegistry\"> </a><a name=\"IHE.PMIR.PatientIdentityRegistry-en-US\"> </a><h2 id=\"title\">IHE PMIR Patient Identity Registry</h2><ul><li>Implementation Guide Version: 1.5.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-10-27 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>PMIR Patient Identity Registry provides capability to manage Master Patient Identity.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or SMART-on-FHIR</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Subscription1-1\">Subscription</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-IHE.PMIR.Subscription.Request.html\">IHE Patient Master Identity Registry Subscription request</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-2\">Patient</a></td><td>�</td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, active, address-city, address-country, address-postalcode, address-state, birthdate, family, gender, given, identifier, telecom, _lastUpdated, mothersMaidenName</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Subscription1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Subscription</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.PMIR.Subscription.Request.html\">https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.Subscription.Request</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For Subscribe to Patient Updates [ITI-94]</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For Mobile Patient Identifier Cross-reference Query [ITI-83]\nand Mobile Patient Demographics Query [ITI-78]</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>Whether the patient record is active</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-city</td><td><code>string</code></td><td><div><p>A city specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-country</td><td><code>string</code></td><td><div><p>A country specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode</td><td><code>string</code></td><td><div><p>A postalCode specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-state</td><td><code>string</code></td><td><div><p>A state specified in an address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>The patient's date of birth</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>family</td><td><code>string</code></td><td><div><p>A portion of the family name of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>Gender of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>given</td><td><code>string</code></td><td><div><p>A portion of the given name of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>A patient identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>telecom</td><td><code>token</code></td><td><div><p>The value in any kind of telecom details of the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/extensions/5.1.0/SearchParameter-patient-extensions-Patient-mothersMaidenName.html\">mothersMaidenName</a></td><td><code>string</code></td><td><div><p>Mother's maiden (unmarried) name, commonly collected to help verify patient identity.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$ihe-pix</td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/PMIR/CapabilityStatement/IHE.PMIR.PatientIdentityRegistry",
"version" : "1.5.1-current",
"name" : "IHE_PMIR_PatientIdentityRegistry",
"title" : "IHE PMIR Patient Identity Registry",
"status" : "active",
"experimental" : false,
"date" : "2022-10-27",
"publisher" : "IHE IT Infrastructure Technical Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "IHE IT Infrastructure Technical Committee",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"description" : "CapabilityStatement for the Patient Identity Registry Actor in the IHE IT Infrastructure Technical Framework Supplement [IHE PMIR](index.html).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "PMIR Patient Identity Registry provides capability to manage Master Patient Identity.",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or SMART-on-FHIR"
},
"resource" : [
{
"type" : "Subscription",
"supportedProfile" : [
"https://profiles.ihe.net/ITI/PMIR/StructureDefinition/IHE.PMIR.Subscription.Request"
],
"documentation" : "For Subscribe to Patient Updates [ITI-94]",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "update"
},
{
"code" : "delete"
}
]
},
{
"type" : "Patient",
"documentation" : "For Mobile Patient Identifier Cross-reference Query [ITI-83]\nand Mobile Patient Demographics Query [ITI-78]",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "active",
"type" : "token",
"documentation" : "Whether the patient record is active"
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"name" : "address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "A postalCode specified in an address"
},
{
"name" : "address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "The patient's date of birth"
},
{
"name" : "family",
"type" : "string",
"documentation" : "A portion of the family name of the patient"
},
{
"name" : "gender",
"type" : "token",
"documentation" : "Gender of the patient"
},
{
"name" : "given",
"type" : "string",
"documentation" : "A portion of the given name of the patient"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
},
{
"name" : "telecom",
"type" : "token",
"documentation" : "The value in any kind of telecom details of the patient"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "mothersMaidenName",
"definition" : "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName",
"type" : "string",
"documentation" : "Mother's maiden (unmarried) name, commonly collected to help verify patient identity."
}
],
"operation" : [
{
"name" : "$ihe-pix",
"definition" : "https://profiles.ihe.net/ITI/PIXm/OperationDefinition/IHE_PIXm_pix"
}
]
}
],
"interaction" : [
{
"code" : "search-system"
}
]
}
],
"messaging" : [
{
"documentation" : "For Mobile Patient Identity Feed [ITI-93]",
"supportedMessage" : [
{
"mode" : "sender",
"definition" : "https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition"
}
]
},
{
"documentation" : "For Mobile Patient Identity Feed [ITI-93]",
"supportedMessage" : [
{
"mode" : "receiver",
"definition" : "https://profiles.ihe.net/ITI/PMIR/StructureDefintion/IHE.PMIR.MessageDefinition"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.